Azure Maps Search Service (stable:2025-01-01)

2025/10/14 • 2 updated methods

Search_GetGeocoding (updated)
Description :  The `Get Geocoding` API is an HTTP `GET` request that returns the longitude and latitude coordinates of the location being searched. In many cases, the complete search service might be too much, for instance if you are only interested in traditional geocoding. Search can also be accessed for address look up exclusively. The geocoding is performed by hitting the geocoding endpoint with just the address or partial address in question. The geocoding search index will be queried for everything above the street level data. No Point of Interest (POIs) will be returned. Note that the geocoder is very tolerant of typos and incomplete addresses. It will also handle everything from exact street addresses or street or intersections as well as higher level geographies such as city centers, counties and states. The response also returns detailed address properties such as street, postal code, municipality, and country/region information.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Search_GetGeocoding",
  "$parameters": [
    {
      "#name": "addressLine",
      "Description": {
        "new": "The official street line of an address relative to the area, as specified by the locality, or postalCode, properties. Typical use of this element would be to provide a street address or any official address.\n\nThis parameter should not be used when the `query` parameter is included in the request.",
        "old": "The official street line of an address relative to the area, as specified by the locality, or postalCode, properties. Typical use of this element would be to provide a street address or any official address.\n\n**If query is given, should not use this parameter.**"
      }
    },
    {
      "#name": "countryRegion",
      "Description": {
        "new": "Signal for the geocoding result to an [ISO 3166-1 Alpha-2 region/country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) that is specified e.g. FR./\n\nThis parameter should not be used when the `query` parameter is included in the request.",
        "old": "Signal for the geocoding result to an [ISO 3166-1 Alpha-2 region/country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) that is specified e.g. FR./\n\n**If query is given, should not use this parameter.**"
      }
    },
    {
      "#name": "adminDistrict",
      "Description": {
        "new": "The country subdivision portion of an address, such as WA.\n\nThis parameter should not be used when the `query` parameter is included in the request.",
        "old": "The country subdivision portion of an address, such as WA.\n\n**If query is given, should not use this parameter.**"
      }
    },
    {
      "#name": "adminDistrict2",
      "Description": {
        "new": "The county for the structured address, such as King.\n\nThis parameter should not be used when the `query` parameter is included in the request.",
        "old": "The county for the structured address, such as King.\n\n**If query is given, should not use this parameter.**"
      }
    },
    {
      "#name": "adminDistrict3",
      "Description": {
        "new": "The named area for the structured address.\n\nThis parameter should not be used when the `query` parameter is included in the request.",
        "old": "The named area for the structured address.\n\n**If query is given, should not use this parameter.**"
      }
    },
    {
      "#name": "locality",
      "Description": {
        "new": "The locality portion of an address, such as Seattle.\n\nThis parameter should not be used when the `query` parameter is included in the request.",
        "old": "The locality portion of an address, such as Seattle.\n\n**If query is given, should not use this parameter.**"
      }
    },
    {
      "#name": "postalCode",
      "Description": {
        "new": "The postal code portion of an address.\n\nThis parameter should not be used when the `query` parameter is included in the request.",
        "old": "The postal code portion of an address.\n\n**If query is given, should not use this parameter.**"
      }
    }
  ]
}

⚼ Request

GET:  /geocode
{
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
Accept-Language:
{
Description: Language in which search results should be returned. Please refer to [Supported Languages](/azure/azure-maps/supported-languages) for details. ,
Required: False ,
}
string ,
top:
{
Description: Maximum number of responses that will be returned. Default: 5, minimum: 1 and maximum: 20. ,
Format: int32 ,
Required: False ,
}
integer ,
query:
{
Description: A string that contains information about a location, such as an address or landmark name. ,
Required: False ,
}
string ,
addressLine:
{
Description: The official street line of an address relative to the area, as specified by the locality, or postalCode, properties. Typical use of this element would be to provide a street address or any official address. This parameter should not be used when the `query` parameter is included in the request. ,
Required: False ,
}
string ,
countryRegion:
{
Description: Signal for the geocoding result to an [ISO 3166-1 Alpha-2 region/country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) that is specified e.g. FR./ This parameter should not be used when the `query` parameter is included in the request. ,
Required: False ,
}
string ,
bbox:
{
Description: A rectangular area on the earth defined as a bounding box object. The sides of the rectangles are defined by longitude and latitude values. When you specify this parameter, the geographical area is taken into account when computing the results of a location query. Example: lon1,lat1,lon2,lat2 ,
Required: False ,
}
array ,
view:
{
Description: A string that represents an [ISO 3166-1 Alpha-2 region/country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). This will alter Geopolitical disputed borders and labels to align with the specified user region. By default, the View parameter is set to “Auto” even if you haven’t defined it in the request. Please refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views. ,
Required: False ,
}
string ,
coordinates:
{
Description: A point on the earth specified as a longitude and latitude. When you specify this parameter, the user’s location is taken into account and the results returned may be more relevant to the user. Example: &coordinates=lon,lat ,
Required: False ,
}
array ,
adminDistrict:
{
Description: The country subdivision portion of an address, such as WA. This parameter should not be used when the `query` parameter is included in the request. ,
Required: False ,
}
string ,
adminDistrict2:
{
Description: The county for the structured address, such as King. This parameter should not be used when the `query` parameter is included in the request. ,
Required: False ,
}
string ,
adminDistrict3:
{
Description: The named area for the structured address. This parameter should not be used when the `query` parameter is included in the request. ,
Required: False ,
}
string ,
locality:
{
Description: The locality portion of an address, such as Seattle. This parameter should not be used when the `query` parameter is included in the request. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code portion of an address. This parameter should not be used when the `query` parameter is included in the request. ,
Required: False ,
}
string ,
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: request id. ,
}
string ,
}
,
$schema:
{
Description: This object is returned from a successful Geocoding call ,
}
{
type:
{
Description: The type of a FeatureCollection object must be FeatureCollection. ,
Enum:
{
FeatureCollection: No description available. ,
}
,
Required: False ,
}
enum ,
features:
{
Required: False ,
}
[
{
type:
{
Description: The type of a feature must be Feature. ,
Enum:
{
Feature: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: ID for feature returned ,
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
type:
{
Description: One of: * Address * RoadBlock * RoadIntersection * Neighborhood * PopulatedPlace * Postcode1 * AdminDivision1 * AdminDivision2 * CountryRegion ,
Required: False ,
}
string ,
confidence:
{
Description: The level of confidence that the geocoded location result is a match. Use this value with the match code to determine for more complete information about the match. The confidence of a geocoded location is based on many factors including the relative importance of the geocoded location and the user’s location, if specified. ,
Enum:
{
High: If the confidence is set to `High`, one or more strong matches were found. Multiple `High` confidence matches are sorted in ranked order by importance when applicable. For example, landmarks have importance but addresses do not. If a request includes a location or a view, then the ranking may change appropriately. For example, a location query for "Paris" returns "Paris, France" and "Paris, TX" both with `High` confidence. "Paris, France" is always ranked first due to importance unless a user location indicates that the user is in or very close to Paris, TX or the map view indicates that the user is searching in that area. ,
Medium: In some situations, the returned match may not be at the same level as the information provided in the request. For example, a request may specify address information and the geocode service may only be able to match a postal code. In this case, if the geocode service has a confidence that the postal code matches the data, the confidence is set to `Medium` and the match code is set to `UpHierarchy` to specify that it could not match all of the information and had to search up-hierarchy. If the location information in the query is ambiguous, and there is no additional information to rank the locations (such as user location or the relative importance of the location), the confidence is set to `Medium`. For example, a location query for "148th Ave, Bellevue" may return "148th Ave SE" and "148th Ave NE" both with `Medium` confidence. If the location information in the query does not provide enough information to geocode a specific location, a less precise location value may be returned and the confidence is set to `Medium`. For example, if an address is provided, but a match is not found for the house number, the geocode result with a Roadblock entity type may be returned. ,
Low: No description available. ,
}
,
Required: False ,
}
enum ,
matchCodes:
{
Description: One or more match code values that represent the geocoding level for each location in the response. For example, a geocoded location with match codes of `Good` and `Ambiguous` means that more than one geocode location was found for the location information and that the geocode service did not have search up-hierarchy to find a match. Similarly, a geocoded location with match codes of `Ambiguous` and `UpHierarchy` implies that a geocode location could not be found that matched all the provided location information, so the geocode service had to search up-hierarchy and found multiple matches at that level. An example of up an `Ambiguous` and `UpHierarchy` result is when you provide complete address information, but the geocode service cannot locate a match for the street address and instead returns information for more than one RoadBlock value. The possible values are: `Good`: The location has only one match or all returned matches are considered strong matches. For example, a query for New York returns several Good matches. `Ambiguous`: The location is one of a set of possible matches. For example, when you query for the street address 128 Main St., the response may return two locations for 128 North Main St. and 128 South Main St. because there is not enough information to determine which option to choose. `UpHierarchy`: The location represents a move up the geographic hierarchy. This occurs when a match for the location request was not found, so a less precise result is returned. For example, if a match for the requested address cannot be found, then a match code of `UpHierarchy` with a RoadBlock entity type may be returned. ,
Required: False ,
}
[
string ,
]
,
address:
{
Description: The address of the result ,
Required: False ,
}
{
addressLine:
{
Description: AddressLine that includes Street Name and Number ,
Required: False ,
}
string ,
locality:
{
Description: locality property ,
Required: False ,
}
string ,
neighborhood:
{
Description: neighborhood property ,
Required: False ,
}
string ,
adminDistricts:
{
Description: The subdivision name in the country or region for an address. This element is typically treated as the first order administrative subdivision, but in some cases it also contains the second, third, or fourth order subdivision in a country, dependency, or region. ,
Required: False ,
}
[
{
name:
{
Description: The name for the corresponding adminDistrict field, For adminDistrict[0], this could be full name of state such as Washington, For adminDistrict[1], this could be the full name of the county ,
Required: False ,
}
string ,
shortName:
{
Description: The short name for the corresponding adminDistrict field, For adminDistrict[0], this could be short name of state such as WA, For adminDistrict[1], this could be the short name of the county ,
Required: False ,
}
string ,
}
,
]
,
postalCode:
{
Description: Postal Code property ,
Required: False ,
}
string ,
countryRegion:
{
Required: False ,
}
{
ISO:
{
Description: ISO of country/region ,
Required: False ,
}
string ,
name:
{
Description: name of country/region ,
Required: False ,
}
string ,
}
,
formattedAddress:
{
Description: Formatted Address property ,
Required: False ,
}
string ,
streetName:
{
Description: The name of the street from formattedAddress ,
Required: False ,
}
string ,
streetNumber:
{
Description: The number in the street, if available, from formattedAddress ,
Required: False ,
}
string ,
intersection:
{
Description: The address of the result. ,
Required: False ,
}
{
baseStreet:
{
Description: Primary street for the location. ,
Required: False ,
}
string ,
secondaryStreet1:
{
Description: The first intersecting street. ,
Required: False ,
}
string ,
secondaryStreet2:
{
Description: If any, the second intersecting street. ,
Required: False ,
}
string ,
intersectionType:
{
Description: Type of intersection. ,
Required: False ,
}
string ,
displayName:
{
Description: Complete name of the intersection. ,
Required: False ,
}
string ,
}
,
}
,
geocodePoints:
{
Description: A collection of geocode points that differ in how they were calculated and their suggested use. ,
Required: False ,
}
[
{
geometry:
{
Description: A valid `GeoJSON Point` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.2) for details. ,
Required: False ,
}
object ,
calculationMethod:
{
Description: The method that was used to compute the geocode point. ,
Enum:
{
Interpolation: The geocode point was matched to a point on a road using interpolation. ,
InterpolationOffset: The geocode point was matched to a point on a road using interpolation with an additional offset to shift the point to the side of the street. ,
Parcel: The geocode point was matched to the center of a parcel. ,
Rooftop: The geocode point was matched to the rooftop of a building. ,
}
,
Required: False ,
}
enum ,
usageTypes:
{
Description: The best use for the geocode point. Each geocode point is defined as a `Route` point, a `Display` point or both. Use `Route` points if you are creating a route to the location. Use `Display` points if you are showing the location on a map. For example, if the location is a park, a `Route` point may specify an entrance to the park where you can enter with a car, and a `Display` point may be a point that specifies the center of the park. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
geometry:
{
Description: A valid `GeoJSON Point` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.2) for details. ,
Required: True ,
}
object ,
bbox:
{
Description: Bounding box. Projection used - EPSG:3857. Please refer to [RFC 7946](https://datatracker.ietf.org/doc/html/rfc7946#section-5) for details. ,
Required: False ,
}
[
number ,
]
,
}
,
]
,
nextLink:
{
Description: The is the link to the next page of the features returned. If it's the last page, no this field. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Search_GetGeocodingBatch (updated)
Description :  The `Get Geocoding Batch` API is an HTTP `POST` request that sends batches of up to **100** queries to the [Geocoding](/rest/api/maps/search/get-geocoding) API in a single request. ### Submit Synchronous Batch Request The Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API. ``` POST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01 ``` ### POST Body for Batch Request To send the _geocoding_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 2 _geocoding_ queries: ``` { "batchItems": [ { "addressLine": "One, Microsoft Way, Redmond, WA 98052", "top": 2 }, { "addressLine": "Pike Pl", "adminDistrict": "WA", "locality": "Seattle", "top": 3 } ] } ``` A _geocoding_ batchItem object can accept any of the supported _geocoding_ [URI parameters](/rest/api/maps/search/get-geocoding#uri-parameters). The batch should contain at least **1** query. ### Batch Response Model The batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests` i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item is of one of the following types: - [`GeocodingResponse`](/rest/api/maps/search/get-geocoding#geocodingresponse) - If the query completed successfully. - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Search_GetGeocodingBatch",
  "$parameters": {
    "geocodingBatchRequestBody": {
      "$properties": {
        "batchItems": {
          "$properties": [
            {
              "#name": "addressLine",
              "Description": {
                "new": "The official street line of an address relative to the area, as specified by the locality, or postalCode, properties. Typical use of this element would be to provide a street address or any official address.\n\nThis parameter should not be used when the `query` parameter is included in the request.",
                "old": "The official street line of an address relative to the area, as specified by the locality, or postalCode, properties. Typical use of this element would be to provide a street address or any official address.\n\n**If query is given, should not use this parameter.**"
              }
            },
            {
              "#name": "countryRegion",
              "Description": {
                "new": "Signal for the geocoding result to an [ISO 3166-1 Alpha-2 region/country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) that is specified e.g. FR./\n\nThis parameter should not be used when the `query` parameter is included in the request.",
                "old": "Signal for the geocoding result to an [ISO 3166-1 Alpha-2 region/country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) that is specified e.g. FR./\n\n**If query is given, should not use this parameter.**"
              }
            },
            {
              "#name": "adminDistrict",
              "Description": {
                "new": "The country subdivision portion of an address, such as WA.\n\nThis parameter should not be used when the `query` parameter is included in the request.",
                "old": "The country subdivision portion of an address, such as WA.\n\n**If query is given, should not use this parameter.**"
              }
            },
            {
              "#name": "adminDistrict2",
              "Description": {
                "new": "The county for the structured address, such as King.\n\nThis parameter should not be used when the `query` parameter is included in the request.",
                "old": "The county for the structured address, such as King.\n\n**If query is given, should not use this parameter.**"
              }
            },
            {
              "#name": "adminDistrict3",
              "Description": {
                "new": "The named area for the structured address.\n\nThis parameter should not be used when the `query` parameter is included in the request.",
                "old": "The named area for the structured address.\n\n**If query is given, should not use this parameter.**"
              }
            },
            {
              "#name": "locality",
              "Description": {
                "new": "The locality portion of an address, such as Seattle.\n\nThis parameter should not be used when the `query` parameter is included in the request.",
                "old": "The locality portion of an address, such as Seattle.\n\n**If query is given, should not use this parameter.**"
              }
            },
            {
              "#name": "postalCode",
              "Description": {
                "new": "The postal code portion of an address.\n\nThis parameter should not be used when the `query` parameter is included in the request.",
                "old": "The postal code portion of an address.\n\n**If query is given, should not use this parameter.**"
              }
            }
          ]
        }
      }
    }
  }
}

⚼ Request

POST:  /geocode:batch
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
Accept-Language:
{
Description: Language in which search results should be returned. Please refer to [Supported Languages](/azure/azure-maps/supported-languages) for details. ,
Required: False ,
}
string ,
geocodingBatchRequestBody:
{
Description: The list of address geocoding queries/requests to process. The list can contain a max of 100 queries and must contain at least 1 query. ,
Required: True ,
}
{
batchItems:
{
Description: The list of queries to process. ,
Required: False ,
}
[
{
optionalId:
{
Description: id of the request which would show in corresponding batchItem ,
Required: False ,
}
string ,
top:
{
Description: Maximum number of responses that will be returned. Default: 5, minimum: 1 and maximum: 20. ,
Format: int32 ,
Required: False ,
}
integer ,
query:
{
Description: A string that contains information about a location, such as an address or landmark name. ,
Required: False ,
}
string ,
addressLine:
{
Description: The official street line of an address relative to the area, as specified by the locality, or postalCode, properties. Typical use of this element would be to provide a street address or any official address. This parameter should not be used when the `query` parameter is included in the request. ,
Required: False ,
}
string ,
countryRegion:
{
Description: Signal for the geocoding result to an [ISO 3166-1 Alpha-2 region/country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) that is specified e.g. FR./ This parameter should not be used when the `query` parameter is included in the request. ,
Required: False ,
}
string ,
bbox:
{
Description: A rectangular area on the earth defined as a bounding box object. The sides of the rectangles are defined by longitude and latitude values. For more information, see Location and Area Types. When you specify this parameter, the geographical area is taken into account when computing the results of a location query. Example: [lon1, lat1, lon2, lat2] ,
Required: False ,
}
[
number ,
]
,
view:
{
Description: A string that specifies an [ISO 3166-1 Alpha-2 region/country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). This will alter Geopolitical disputed borders and labels to align with the specified user region. ,
Required: False ,
}
string ,
coordinates:
{
Description: A point on the earth specified as a longitude and latitude. When you specify this parameter, the user’s location is taken into account and the results returned may be more relevant to the user. Example: [lon, lat] ,
Required: False ,
}
[
number ,
]
,
adminDistrict:
{
Description: The country subdivision portion of an address, such as WA. This parameter should not be used when the `query` parameter is included in the request. ,
Required: False ,
}
string ,
adminDistrict2:
{
Description: The county for the structured address, such as King. This parameter should not be used when the `query` parameter is included in the request. ,
Required: False ,
}
string ,
adminDistrict3:
{
Description: The named area for the structured address. This parameter should not be used when the `query` parameter is included in the request. ,
Required: False ,
}
string ,
locality:
{
Description: The locality portion of an address, such as Seattle. This parameter should not be used when the `query` parameter is included in the request. ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code portion of an address. This parameter should not be used when the `query` parameter is included in the request. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
summary:
{
Description: Summary for the batch request ,
Required: False ,
}
{
successfulRequests:
{
Description: Number of successful requests in the batch ,
Format: int32 ,
Required: False ,
}
integer ,
totalRequests:
{
Description: Total number of requests in the batch ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
batchItems:
{
Description: Array containing the batch results. ,
Required: False ,
}
[
{
optionalId:
{
Description: id of the batchItem which would be the same as the id in the request ,
Required: False ,
}
string ,
type:
{
Description: The type of a FeatureCollection object must be FeatureCollection. ,
Enum:
{
FeatureCollection: No description available. ,
}
,
Required: False ,
}
enum ,
features:
{
Required: False ,
}
[
{
type:
{
Description: The type of a feature must be Feature. ,
Enum:
{
Feature: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: ID for feature returned ,
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
type:
{
Description: One of: * Address * RoadBlock * RoadIntersection * Neighborhood * PopulatedPlace * Postcode1 * AdminDivision1 * AdminDivision2 * CountryRegion ,
Required: False ,
}
string ,
confidence:
{
Description: The level of confidence that the geocoded location result is a match. Use this value with the match code to determine for more complete information about the match. The confidence of a geocoded location is based on many factors including the relative importance of the geocoded location and the user’s location, if specified. ,
Enum:
{
High: If the confidence is set to `High`, one or more strong matches were found. Multiple `High` confidence matches are sorted in ranked order by importance when applicable. For example, landmarks have importance but addresses do not. If a request includes a location or a view, then the ranking may change appropriately. For example, a location query for "Paris" returns "Paris, France" and "Paris, TX" both with `High` confidence. "Paris, France" is always ranked first due to importance unless a user location indicates that the user is in or very close to Paris, TX or the map view indicates that the user is searching in that area. ,
Medium: In some situations, the returned match may not be at the same level as the information provided in the request. For example, a request may specify address information and the geocode service may only be able to match a postal code. In this case, if the geocode service has a confidence that the postal code matches the data, the confidence is set to `Medium` and the match code is set to `UpHierarchy` to specify that it could not match all of the information and had to search up-hierarchy. If the location information in the query is ambiguous, and there is no additional information to rank the locations (such as user location or the relative importance of the location), the confidence is set to `Medium`. For example, a location query for "148th Ave, Bellevue" may return "148th Ave SE" and "148th Ave NE" both with `Medium` confidence. If the location information in the query does not provide enough information to geocode a specific location, a less precise location value may be returned and the confidence is set to `Medium`. For example, if an address is provided, but a match is not found for the house number, the geocode result with a Roadblock entity type may be returned. ,
Low: No description available. ,
}
,
Required: False ,
}
enum ,
matchCodes:
{
Description: One or more match code values that represent the geocoding level for each location in the response. For example, a geocoded location with match codes of `Good` and `Ambiguous` means that more than one geocode location was found for the location information and that the geocode service did not have search up-hierarchy to find a match. Similarly, a geocoded location with match codes of `Ambiguous` and `UpHierarchy` implies that a geocode location could not be found that matched all the provided location information, so the geocode service had to search up-hierarchy and found multiple matches at that level. An example of up an `Ambiguous` and `UpHierarchy` result is when you provide complete address information, but the geocode service cannot locate a match for the street address and instead returns information for more than one RoadBlock value. The possible values are: `Good`: The location has only one match or all returned matches are considered strong matches. For example, a query for New York returns several Good matches. `Ambiguous`: The location is one of a set of possible matches. For example, when you query for the street address 128 Main St., the response may return two locations for 128 North Main St. and 128 South Main St. because there is not enough information to determine which option to choose. `UpHierarchy`: The location represents a move up the geographic hierarchy. This occurs when a match for the location request was not found, so a less precise result is returned. For example, if a match for the requested address cannot be found, then a match code of `UpHierarchy` with a RoadBlock entity type may be returned. ,
Required: False ,
}
[
string ,
]
,
address:
{
Description: The address of the result ,
Required: False ,
}
{
addressLine:
{
Description: AddressLine that includes Street Name and Number ,
Required: False ,
}
string ,
locality:
{
Description: locality property ,
Required: False ,
}
string ,
neighborhood:
{
Description: neighborhood property ,
Required: False ,
}
string ,
adminDistricts:
{
Description: The subdivision name in the country or region for an address. This element is typically treated as the first order administrative subdivision, but in some cases it also contains the second, third, or fourth order subdivision in a country, dependency, or region. ,
Required: False ,
}
[
{
name:
{
Description: The name for the corresponding adminDistrict field, For adminDistrict[0], this could be full name of state such as Washington, For adminDistrict[1], this could be the full name of the county ,
Required: False ,
}
string ,
shortName:
{
Description: The short name for the corresponding adminDistrict field, For adminDistrict[0], this could be short name of state such as WA, For adminDistrict[1], this could be the short name of the county ,
Required: False ,
}
string ,
}
,
]
,
postalCode:
{
Description: Postal Code property ,
Required: False ,
}
string ,
countryRegion:
{
Required: False ,
}
{
ISO:
{
Description: ISO of country/region ,
Required: False ,
}
string ,
name:
{
Description: name of country/region ,
Required: False ,
}
string ,
}
,
formattedAddress:
{
Description: Formatted Address property ,
Required: False ,
}
string ,
streetName:
{
Description: The name of the street from formattedAddress ,
Required: False ,
}
string ,
streetNumber:
{
Description: The number in the street, if available, from formattedAddress ,
Required: False ,
}
string ,
intersection:
{
Description: The address of the result. ,
Required: False ,
}
{
baseStreet:
{
Description: Primary street for the location. ,
Required: False ,
}
string ,
secondaryStreet1:
{
Description: The first intersecting street. ,
Required: False ,
}
string ,
secondaryStreet2:
{
Description: If any, the second intersecting street. ,
Required: False ,
}
string ,
intersectionType:
{
Description: Type of intersection. ,
Required: False ,
}
string ,
displayName:
{
Description: Complete name of the intersection. ,
Required: False ,
}
string ,
}
,
}
,
geocodePoints:
{
Description: A collection of geocode points that differ in how they were calculated and their suggested use. ,
Required: False ,
}
[
{
geometry:
{
Description: A valid `GeoJSON Point` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.2) for details. ,
Required: False ,
}
object ,
calculationMethod:
{
Description: The method that was used to compute the geocode point. ,
Enum:
{
Interpolation: The geocode point was matched to a point on a road using interpolation. ,
InterpolationOffset: The geocode point was matched to a point on a road using interpolation with an additional offset to shift the point to the side of the street. ,
Parcel: The geocode point was matched to the center of a parcel. ,
Rooftop: The geocode point was matched to the rooftop of a building. ,
}
,
Required: False ,
}
enum ,
usageTypes:
{
Description: The best use for the geocode point. Each geocode point is defined as a `Route` point, a `Display` point or both. Use `Route` points if you are creating a route to the location. Use `Display` points if you are showing the location on a map. For example, if the location is a park, a `Route` point may specify an entrance to the park where you can enter with a car, and a `Display` point may be a point that specifies the center of the park. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
geometry:
{
Description: A valid `GeoJSON Point` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.2) for details. ,
Required: True ,
}
object ,
bbox:
{
Description: Bounding box. Projection used - EPSG:3857. Please refer to [RFC 7946](https://datatracker.ietf.org/doc/html/rfc7946#section-5) for details. ,
Required: False ,
}
[
number ,
]
,
}
,
]
,
nextLink:
{
Description: The is the link to the next page of the features returned. If it's the last page, no this field. ,
Required: False ,
}
string ,
error:
{
Description: The error detail. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The is the link to the next page of the features returned. If it's the last page, no this field. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}